Skip to content

docs: clarify contract ID placeholders and env vars in deployments.md#673

Merged
AnnabelJoe merged 2 commits into
AnnabelJoe:mainfrom
ZainabJanee:fix/522-deployment-docs
Jun 27, 2026
Merged

docs: clarify contract ID placeholders and env vars in deployments.md#673
AnnabelJoe merged 2 commits into
AnnabelJoe:mainfrom
ZainabJanee:fix/522-deployment-docs

Conversation

@ZainabJanee

Copy link
Copy Markdown
Contributor

Summary

Closes #522

Rewrites docs/deployments.md so maintainers clearly know which values are placeholders and how to fill them in.

Changes

  • Replace ambiguous _(set after first deploy)_ with explicit <PLACEHOLDER> tokens (e.g. <TESTNET_ENERGY_TOKEN_ID>) that cannot be mistaken for real contract IDs.
  • Add a placeholder convention note at the top of the file.
  • Add required environment variable blocks for both testnet and mainnet, matching the variable names in .env.example.
  • Add a numbered "How to update this file" section linking to docs/DEPLOYMENT.md.

Tested

Documentation-only change; no code modified.

ZainabJanee and others added 2 commits June 26, 2026 13:16
Closes AnnabelJoe#522

- Replace ambiguous '_(set after first deploy)_' text with explicit
  <PLACEHOLDER> tokens so maintainers know what to fill in.
- Add required env var blocks for both testnet and mainnet.
- Add placeholder convention note at the top of the file.
- Link update steps to DEPLOYMENT.md for the full deploy guide.
@drips-wave

drips-wave Bot commented Jun 27, 2026

Copy link
Copy Markdown

@ZainabJanee Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@AnnabelJoe AnnabelJoe merged commit a449c8b into AnnabelJoe:main Jun 27, 2026
2 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update deployment docs with actual or placeholder contract IDs

2 participants